get started instructions update, version bump

sylefeb · Jan 21, 2024 · ba35156 · ba35156
1 parent b75996f
commit ba35156
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 13 deletions.
diff --git a/GetStarted_Linux.md b/GetStarted_Linux.md
@@ -3,13 +3,17 @@
 ## Compiling Silice
 
 Hopefully this will be as simple as running `./get_started_linux.sh`
-Beware that this script is installing dependencies and will request sudo access. If that is not ok, please open the script and see what it wants to install.
+Beware that this script is installing dependencies and will request sudo access.
+If that is not ok, please open the script and see what it wants to install.
+The script also installs Silice on the system, using standard paths (`/usr/local/bin` and `/usr/local/shared/silice`).
+Finally, the script appends paths to `.bashrc`.
 
-Dependencies are installed by the scripts `install_dependencies_*.sh`. The `get_started_linux.sh` script attempts to detect your distrib to call the corresponding dependencies installation script, but if that fails you may have to manually install the dependencies. In such a case, please refer to the script's contents to see what's needed. Note that the Java jre/jdk are only required for compilation.
+## Notes on dependencies
 
-The `get_started_linux.sh` script will install all dependencies, including pre-compiled binaries for the FPGA toolchain (from [oss-cad-suite](https://github.com/YosysHQ/oss-cad-suite-build)).
-It will then compile and install Silice using standard paths (`/usr/local/bin` and `/usr/local/shared/silice`).
+The `get_started_linux.sh` script calls the scripts `install_dependencies_*.sh` to install dependencies. It attempts to detect your distrib to call the corresponding dependencies installation script, but if that fails you may have to manually install the dependencies. In such a case, please refer to the script's contents to see what is needed. Note that the Java jre/jdk are only required for compilation.
 
-## Testing
+The script also downloads and sets up pre-compiled binaries for the FPGA toolchain (from [oss-cad-suite](https://github.com/YosysHQ/oss-cad-suite-build)). These are placed in the `Silice/tools/`, and environment variables are set by adding a line to the user's `.bashrc`
 
-Time to [run a few tests](GetStarted.md#testing).
+## Testing after installation
+
+Time to [run a few tests](GetStarted.md#testing) and [start having fun!](projects/README.md)
diff --git a/GetStarted_Windows.md b/GetStarted_Windows.md
@@ -18,9 +18,8 @@ The prompt should look like this (note the MinGW64 label in purple):
 
 Then, from the prompt, enter the Silice directory and type: `./get_started_mingw64.sh`.
 
-> **Note:** The script adds Silice and the FPGA toolchain to PATH in` ~/.bashrc`. Open a new MinGW64 prompt to start using Silice.
-
-> **Note:** This automatically downloads a pre-compiled FPGA toolchain from [oss-cad-suite](https://github.com/YosysHQ/oss-cad-suite-build) as well as installs required MinGW64 packages. For details please refer to the [script source code](get_started_mingw64.sh).
+> **Note:** The script downloads necessary MinGW packages, compiles and installs Silice using standard paths (`/usr/local/bin` and `/usr/local/shared/silice`) as well as downloads and sets up the [oss-cad-suite](https://github.com/YosysHQ/oss-cad-suite-build) FPGA toolchain, adding a line in ` ~/.bashrc`. Open a new MinGW64 prompt to start using Silice.
+For details please refer to the [script source code](get_started_mingw64.sh).
 
 ## Drivers
 

diff --git a/get_started_linux.sh b/get_started_linux.sh
@@ -27,7 +27,7 @@ else
 		if [ "$ID" == "debian"  ] || [ "$ID_LIKE" == "debian"  ]; then
 			sudo ./install_dependencies_debian_like.sh
 		else
-			echo "Cannot determine Linux distrib to install dependencies\n(if this fails please run the install_dependencies script that matches your distrib)."			
+			echo "Cannot determine Linux distrib to install dependencies\n(if this fails please run the install_dependencies script that matches your distrib)."
 		fi
 	fi
 fi
@@ -47,7 +47,6 @@ cd tools ; tar xvfz ../oss-cad-suite-linux-x64-$OSS_CAD_YEAR$OSS_CAD_MONTH$OSS_C
 
 # -------------- add path to .bashrc ------------------------
 DIR=`pwd`
-echo 'export PATH=$PATH:'$DIR/bin >> ~/.bashrc
 echo 'source '$DIR'/tools/oss-cad-suite-env.sh' >> ~/.bashrc
 
 echo ""

diff --git a/get_started_mingw64.sh b/get_started_mingw64.sh
@@ -51,7 +51,6 @@ cd tools ; ../oss-cad-suite-windows-x64-$OSS_CAD_YEAR$OSS_CAD_MONTH$OSS_CAD_DAY.
 
 # -------------- add path to .bashrc ------------------------
 DIR=`pwd`
-echo 'export PATH=$PATH:'$DIR/bin >> ~/.bashrc
 echo 'source '$DIR'/tools/oss-cad-suite-env.sh' >> ~/.bashrc
 
 echo ""

diff --git a/src/silice.cpp b/src/silice.cpp
@@ -48,7 +48,7 @@ int main(int argc, char **argv)
 {
   try {
 
-    const std::string version_string = std::string(" 0.2.0") + " " + c_GitHash;
+    const std::string version_string = std::string(" 0.2.3") + " " + c_GitHash;
     //                                               ^ ^ ^
     //                                               | | |
     //                                               | | \_ increments with features in wip/draft (x.x.x)