path: root/README

           ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
                                 DORADO
               Collection of Algorithms used in Computer
                                Graphics

                                Andinus
           ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━


Table of Contents
─────────────────

Installation
Development
License


━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 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>
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━


Installation
════════════

  The project is written in [Svelte].

  ┌────
  │ # Clone the project.
  │ 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.
  └────


[Svelte] <https://svelte.dev>


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
═══════

  ┌────
  │ Dorado - Collection of Algorithms used in Computer Graphics
  │ Copyright (C) 2021, Andinus <andinus@nand.sh>
  │
  │ This program is free software: you can redistribute it and/or modify
  │ it under the terms of the GNU Affero General Public License as published
  │ by the Free Software Foundation, either version 3 of the License, or
  │ (at your option) any later version.
  │
  │ This program is distributed in the hope that it will be useful,
  │ but WITHOUT ANY WARRANTY; without even the implied warranty of
  │ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  │ GNU Affero General Public License for more details.
  │
  │ You should have received a copy of the GNU Affero General Public License
  │ along with this program.  If not, see <https://www.gnu.org/licenses/>.
  └────