aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
author George L. Albany <Megacake1234@gmail.com>2023-10-20 21:19:11 +0200
committer GitHub <noreply@github.com>2023-10-20 21:19:11 +0200
commit7bda541557722b2a244e80796c612b735d8b5cf7 (patch)
treeb535be7c17bc5da1f864033d1ab8837ddee689ab
parent286b51604faa294ec7637bda04f1e47eeb00b246 (diff)
parent20390a79dc35dd3990929e481cf39436c52180bc (diff)
Merge pull request #63 from OpenVicProject/add/readme
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a2bc33b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# OpenVic-Simulation
+Repo of the OpenVic-Simulation Library for [OpenVic](https://github.com/OpenVicProject/OpenVic)
+
+## Quickstart Guide
+For detailed instructions, view the OpenVic Contributor Quickstart Guide [here](https://github.com/OpenVicProject/OpenVic/blob/master/docs/contribution-quickstart-guide.md)
+
+## Required
+* [scons](https://scons.org/)
+
+## Build Instructions
+1. Install [scons](https://scons.org/) for your system.
+2. Run the command `git submodule update --init --recursive` to retrieve all related submodules.
+3. Run `scons` in the project root, you should see a openvic-simulation.headless file in `bin`.
+
+## Link Instructions
+1. Call `ovsim_env = SConscript("openvic-simulation/SConstruct")`
+2. Use the values stored in the `ovsim_env.openvic_simulation` to link and compile against:
+
+| Variable Name | Description | Correlated ENV variable |
+| --- | --- | --- |
+| `LIBPATH` | Library path list | `env["LIBPATH"]` |
+| `LIBS` | Library files names in the library paths | `env["LIBS"]` |
+| `INCPATH` | Library include files | `env["CPPPATH"]` |