about summary refs log tree commit diff stats
path: root/README.org
diff options
context:
space:
mode:
authorAndinus <andinus@nand.sh>2021-10-10 19:25:30 +0530
committerAndinus <andinus@nand.sh>2021-10-10 19:25:30 +0530
commite62385395a3ac5f7c36ecefcd613f48cfa15d4ad (patch)
tree23bc0c31633401eada0960c4c3b7cbb88869768c /README.org
parente3c4aaf6c20ac1aab52ba30c93f1d360b21dfff8 (diff)
downloaddorado-e62385395a3ac5f7c36ecefcd613f48cfa15d4ad.tar.gz
Add plotly, update README to add Development notes
Diffstat (limited to 'README.org')
-rw-r--r--README.org22
1 files changed, 18 insertions, 4 deletions
diff --git a/README.org b/README.org
index b813455..3e25781 100644
--- a/README.org
+++ b/README.org
@@ -3,24 +3,38 @@
 #+export_file_name: index
 #+setupfile: ~/.emacs.d/org-templates/projects.org
 
-| Website         | https://andinus.nand.sh/dorado    |
+| Demo    | https://andinus.unfla.me/dorado          |
+| Website | https://andinus.unfla.me/projects/dorado |
+
 | Source          | https://git.unfla.me/dorado       |
 | GitHub (mirror) | https://github.com/andinus/dorado |
 
-* Development
+* Installation
 
 The project is written in [[https://svelte.dev][Svelte]].
 
 #+begin_src sh
 # Clone the project.
-git clone https://git.tilde.institute/andinus/cg-algorithms
-cd cg-algorithms
+git clone https://git.tilde.institute/andinus/dorado
+cd dorado
 
 npm install # Get dependencies.
 npm run dev # Build for development.
 npm run build # Build for deployment.
 #+end_src
 
+* Development
+
+- ~src/App.svelte~: Main application.
+- ~src/Home.svelte~: Home page.
+- ~src/Navbar.svelte~: Navbar (links to all algorithms).
+- ~src/algorithms~: Algorithms directory.
+
+** Adding a new Algorithm
+
+To add a new algorithm, create a file in ~src/algorithms~ and add the
+entry to ~src/Navbar.svelte~.
+
 * License
 
 #+begin_src