* Updated documentation (lxterm is now called litex_term)

BrunoLevy · BrunoLevy · commit eefc3af83483 · 2023-06-14T18:59:04.000+02:00
* Added orange-crab documentation
* small fix in tinyraytracer (colliding min/max macros)
diff --git a/LiteX/README.md b/LiteX/README.md
@@ -46,6 +46,7 @@ Synthesize
 Instructions to synthesize are different, depending on the board you have.
 
 - [ULX3S](ULX3S.md)
+- [OrangeCrab](orange_crab.md)
 - [Other boards](litex-boards.md)
 
 Connect to the SoC
@@ -57,7 +58,7 @@ of `/dev/ttyUSBnnn`), use `$dmesg` right after plugging it (or try
 different values). Supposing it is `ttyUSB0`, do:
 
 ```
-  $lxterm /dev/ttyUSB0
+  $litex_term /dev/ttyUSB0
 ```
 
 Then press `<enter>`. You will see the `litex>` prompt.
diff --git a/LiteX/ULX3S.md b/LiteX/ULX3S.md
@@ -20,7 +20,8 @@ improvements as compared to the original LiteX design (see
   FOR NOW, NEEDS TO BE ADAPTED TO NEW LITEX)
 - fixed a video timing problem 
 - added a crude Blitter to accelerate some graphic functions (clear, fillrect, fillpoly)
-
+- NOTE: you may need to do a [simple modification](https://github.com/enjoy-digital/litex/issues/1712) in
+  one of LiteX's files to be able to access the SDCard.
 
 To generate the bitstream for the ULX3S, you will first need to:
 
@@ -51,7 +52,7 @@ FemtoRV directly from its github repository, great !). It will also
 compile the BIOS, synthesize the gateware and send it to the
 device. If everything went well, you will see the colorful 'knight
 driver' blinky of victory on the LEDs. Now you can connect to the SoC
-with `lxterm /dev/ttyUSB0`. 
+with `litex_term /dev/ttyUSB0`. 
 
 Now let us see how to write some [software for our SoC](software/README.md).
 
diff --git a/LiteX/orange_crab.md b/LiteX/orange_crab.md
@@ -0,0 +1,40 @@
+LiteX Instructions for OrangeCrab:
+----------------------------------
+
+Before starting:
+
+Make sure you have updated `udev rules` to allow accessing the USB port of the OrangeCrab in
+user mode, as explained [https://github.com/BrunoLevy/learn-fpga/blob/master/FemtoRV/TUTORIALS/toolchain.md#orangecrab-ecp5](here).
+
+Synthesize and program:
+```
+$ cd learn-fpga/LiteX
+$ python3 -m litex_boards.targets.gsd_orangecrab --device 25F --cpu-type femtorv --cpu-variant gracilis --with-spi-sdcard --build --load --ecppack-compress
+```
+(replace `25F` with the one in your device (there is also a `45F` and a `85F` version).
+
+Build software:
+Edit `software/makefile.inc`
+- set `LITEX_DIR` and `LEARNFPGA_DIR`
+- set  `LITEX_PLATFORM` to `gsd_orangecrab` 
+```
+$ cd software/LiteOS
+$ make
+$ cd ../Programs
+$ make hello.elf
+```
+
+Copy `LiteOS/boot.bin` and `Programs/hello.elf` to a SDCard
+Insert the SDCard in the OrangeCrab
+
+```
+$ litex_term /dev/ttyACM0
+$ reboot
+```
+
+This should load LiteOS from the SDCard
+
+Run a simple program:
+```
+liteOS> run hello.elf
+```
diff --git a/LiteX/software/DemoBundle/demos/tinyraytracer.c b/LiteX/software/DemoBundle/demos/tinyraytracer.c
@@ -16,6 +16,15 @@
 
 /*******************************************************************/
 
+#ifdef min
+#undef min
+#endif
+
+#ifdef max
+#undef max
+#endif
+
+
 typedef int BOOL;
 
 static inline float max(float x, float y) { return x>y?x:y; }
diff --git a/LiteX/software/LiteOS/README.md b/LiteX/software/LiteOS/README.md
@@ -31,7 +31,7 @@ slot of your FPGA board.
 Step 3: run
 -----------
 Reboot the board. The LiteX BIOS automatically finds `boot.bin` on the
-SDCard and loads it. Connect to it using `lxterm /dev/ttyUSBnnn` where
+SDCard and loads it. Connect to it using `litex_term /dev/ttyUSBnnn` where
 `nnn` depends on the circumstances (it is 0 in most cases). If everything
 went well, you will see the LiteOS prompt.
 
diff --git a/LiteX/software/Programs/README.md b/LiteX/software/Programs/README.md
@@ -8,7 +8,7 @@ Compile the programs:
 ```
 $ make
 ```
-Then copy all `.elf` files to the SDCard. Connect to the SoC (`lxterm
+Then copy all `.elf` files to the SDCard. Connect to the SoC (`litex_term
 /dev/ttyUSBnnn`), and verify that the programs are there:
 ```
 liteOS> catalog
