Skip to content

Commit

Permalink
More readme
Browse files Browse the repository at this point in the history 
Signed-off-by: Harry Chen <i@harrychen.xyz>
  • Loading branch information
@Harry-Chen
Harry-Chen committed Jun 28, 2018
1 parent c0bc3ba commit 7e7e14b
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
View file
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -22,18 +22,25 @@ There are some fancy commands. For example,
3. Run `bb` to show an ASCII-art demo. 3. Run `bb` to show an ASCII-art demo.
4. Run `cacafire` to show the colored fire. 4. Run `cacafire` to show the colored fire.


Some other demos are in the `demo` folder, you can also explore for more possibilities!

## Notice ## Notice


1. The default baud is 3M, which is not a standard baud. You might need to modify the configuration of `getty` to make it communicate normally with the FPGA. Or you can slow it down in `src/DataType.svh`, which will lead to bad experiences such as slow refreshing rate. 1. The default baud is 3M, which is not a standard baud. You might need to modify the configuration of `getty` to make it communicate normally with the FPGA. Or you can slow it down (for example, 115200) in `src/DataType.svh`, which will lead to bad experiences such as slow refreshing rate.
2. There might be some timing issue with the VGA signal. You can adjust your monitor manually if it doesn't display image as expected. 2. There might be some timing issue with the VGA signal. You can adjust your monitor manually if it doesn't display image as expected.
3. When `TERM=vt220`, there is no color support but everything will work well. When `TERM=xterm-256color`, there is color support, but there might be some strange behaviors for we have not implemented all instructions in that mode. 3. When `TERM=vt220`, there is no color support but everything will work well. When `TERM=xterm-256color`, there is color support, but there might be some strange behaviors for we have not implemented all instructions in that mode.
4. `src/storage` contains some `mif` files that we have designed as the content of initial screen of the console. The default used is `TextRamLogBig.mif`, the others are all in `80*40` chars so cannot fill the whole screen.

## Test and Simulation

There are some test benches in folder `testbench`. You can use ModelSim to run simulation with source file properly attached. We also provide a debug probe in the top module with some signal linked to it. The two 7-segment LEDs on board can also show the internal status of the console, or the `CommandsParser`, to be precise.


## Documentation ## Documentation


You can refer to `doc/report.pdf` for a detailed explanation, or `doc/presentation.pdf` for a quick view of this project. You can refer to `doc/report.pdf` for a detailed explanation, or `doc/presentation.pdf` for a quick view of this project . `doc/reference` contains some details and specifications of console that we have implemented.


The source code is __not__ well documented, we sincerely apologize for the consequential inconvenience. The source code is __not__ very well documented, we sincerely apologize for the consequential inconvenience.


## Licence ## License


This project is released under GPLv3, see `LICENSE` for legal text. This project is released under GPLv3, see `LICENSE` for legal text.

0 comments on commit 7e7e14b

Please sign in to comment.