updating readme

NCAR · Aug 13, 2024 · 317f9f2 · 317f9f2
1 parent fa80056
commit 317f9f2
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -482,3 +482,6 @@ $RECYCLE.BIN/
 
 # Vim temporary swap files
 *.swp
+
+obj
+bin
diff --git a/README.md b/README.md
@@ -6,6 +6,26 @@ API for the Chemistry Cafe web application found here https://github.com/NCAR/ch
 
 # Getting Started
 
+## Command line
+
+Install the `dotnet` tool
+
+### macOS
+
+```
+brew install dotnet
+```
+
+---
+
+Then build the project
+
+```
+dotnet run
+```
+
+This should start a server. You should be able to access a swagger page on the port that the server stars, for example [http://localhost:5134/swagger](http://localhost:5134)
+
 ## Installing the API locally
 To build and install Chemistry Cafe locally, you must have Visual Studio 2022.
-Original file line number
+Diff line change
@@ Expand Up / @@ -482,3 +482,6 @@ $RECYCLE.BIN/ @@
     # Vim temporary swap files
     *.swp
+    obj
+    bin