Skip to content

Commit d78b4e1

Browse files
committed
refactor: Reorganize project directory structure
- Restructured documentation files into logical directories: * Moved tutorials and docs to pages/ with topic-based subdirectories * Consolidated platform docs under pages/platforms/ * Organized toolchain docs under pages/toolchains/ - Unified resource files under resource/ directory: * Board-specific resources moved to resource/de0_nano/ * Simulator configs moved to resource/or1ksim/ * All images centralized in resource/images/ - Updated _config.yml and index.md to reflect new structure This restructuring improves project maintainability and document discoverability by establishing a clearer and more logical file organization. Signed-off-by: chenmiao <chenmiao.ku@gmail.com>
1 parent a96f86b commit d78b4e1

28 files changed

+21
-21
lines changed

_config.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,7 @@ theme: just-the-docs
33
color_scheme: or1k
44
repository: openrisc/tutorials
55

6-
include: ['debugging', 'de0_nano', 'docs', 'or1ksim', 'platform', 'sw']
6+
include: [
7+
'pages',
8+
'resouce',
9+
]

de0_nano/.gitignore

Lines changed: 0 additions & 3 deletions
This file was deleted.

index.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,8 @@ or1k_interrupts_disable(void)
7878
}
7979
```
8080
81-
See the [newlib tutorial](newlib.html) for details on how to setup the newlib development
82-
environment. Or checkout the [Quickstart tutorial](images.html) for docker images
81+
See the [newlib tutorial](./pages/toolchains/newlib.html) for details on how to setup the newlib development
82+
environment. Or checkout the [Quickstart tutorial](./pages/quick_start.html) for docker images
8383
that have the newlib environment out of the box.
8484
8585
## Tools (partially required)
@@ -92,8 +92,8 @@ OpenRISC. You can install it as described
9292
9393
Featured in:
9494
95-
* [De0 Nano](de0_nano/) - De0 Nano FPGA development board platform tutorial.
96-
* [Quickstart Images](images.html) - Docker verilog development environment
95+
* [De0 Nano](./pages/platforms/fusesoc/) - De0 Nano FPGA development board platform tutorial.
96+
* [Quickstart Images](./pages/quick_start.html) - Docker verilog development environment
9797
9898
### OpenOCD
9999
@@ -103,8 +103,8 @@ install a current version.
103103
104104
Featured in:
105105
106-
* [De0 Nano](de0_nano/) - De0 Nano FPGA development board platform tutorial.
107-
* [Debugging](docs/Debugging.html) - OpenOCD debugging cheat sheet.
106+
* [De0 Nano](./pages/platforms/fusesoc/) - De0 Nano FPGA development board platform tutorial.
107+
* [Debugging](./pages/platforms/debugging.html) - OpenOCD debugging cheat sheet.
108108
109109
### Quartus Prime
110110
@@ -115,7 +115,7 @@ required for some tutorials.
115115
116116
Featured in:
117117
118-
* [De0 Nano](de0_nano/) - De0 Nano FPGA development board platform tutorial.
118+
* [De0 Nano](./pages/platforms/fusesoc/) - De0 Nano FPGA development board platform tutorial.
119119
120120
For downloading the free version, visit the
121121
[Intel website](https://www.intel.com/content/www/us/en/software-kit/849769/intel-quartus-prime-lite-edition-design-software-version-24-1-for-linux.html) and
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/Linux.md renamed to pages/linux/linux.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,5 +76,5 @@ halt; load_image vmlinux; reg r3 0; reg npc 0x100; resume
7676
The kernel image is now available as an elf file called `vmlinux`. This file can be used as any other bare-metal program for OpenRISC. To test the Linux image, you can:
7777
* Run it in the reference C simulator (or1ksim)
7878
* Run it on a simulated RTL model (Most likely extremely slow, unless using verilator)
79-
* [Load it to RAM on an FPGA board with a debugger](Debugging.html)
79+
* [Load it to RAM on an FPGA board with a debugger](../platforms/debugging.html)
8080
* Program it to non-volatile flash on an FPGA board
File renamed without changes.

fusesoc.md renamed to pages/platforms/fusesoc.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ parent: Platforms
77

88
The FuseSoC build system, dependency manager and fpga integration platform
99
allows for easy creation of OpenRISC systems. If is featured in our
10-
[Quick Start with Docker Images](images/) as our main fpga development
10+
[Quick Start with Docker Images](../quick_start.html) as our main fpga development
1111
platform. For in depth documentation see:
1212

1313
* [FuseSoC Manual](https://fusesoc.readthedocs.io/en/stable/index.html) - Full documentation.

de0_nano/index.md renamed to pages/platforms/fusesoc/de0_nano.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ parent: FuseSoC
1313
* OpenOCD
1414
* The quartus FPGA design software
1515
* `fusesoc` - The [FuseSoC build system](../fusesoc.html).
16-
* `or1k-elf-` Toolchain as installed in our [newlib tutorial](../newlib.html).
16+
* `or1k-elf-` Toolchain as installed in our [newlib tutorial](../../toolchains/newlib.html).
1717

1818
#### Files
1919

20-
* [hello.c](../sw/hello/hello.c) - A Hello World test program.
21-
* [timer.c](../sw/timer/timer.c) - A baremetal example using the OpenRISC timer api's provided by newlib.
20+
* [hello.c](../../../resource/de0_nano/sw/hello/hello.c) - A Hello World test program.
21+
* [timer.c](../../../resource/de0_nano/sw/timer/timer.c) - A baremetal example using the OpenRISC timer api's provided by newlib.
2222

2323
## DE0 Nano
2424

@@ -46,7 +46,7 @@ computer. If you want to use UART, an extra dongle is needed. Any
4646
USB-UART adapter can be used. You need to connect it to the header on
4747
the bottom of the board as depicted below.
4848

49-
![uart](doc/uart.png "Connect UART to board")
49+
![uart](../../../resource/images/uart.png "Connect UART to board")
5050

5151
### Setup the Environment
5252

0 commit comments

Comments
 (0)