Skip to content

Commit

Permalink
Filled the gaps in README
Browse files Browse the repository at this point in the history
  • Loading branch information
iWas-Coder committed Apr 1, 2024
1 parent dfdc54d commit c397704
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.org
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ You should have received a copy of the GNU General Public License along with Spa
* Table of Contents :toc:
- [[#projects-roadmap][Project's Roadmap]]
- [[#build-from-source][Build from source]]
- [[#get-code][Get code]]
- [[#get-the-code][Get the code]]
- [[#dependencies][Dependencies]]
- [[#debianubuntu][Debian/Ubuntu]]
- [[#fedora][Fedora]]
Expand All @@ -101,19 +101,21 @@ For information about the detailed project roadmap, including delivered mileston

* Build from source

(...)
In order to build /Sparky/ from source, preparation is needed so as to the environment is properly setup and ready.

** Get code
** Get the code

(...)
First, download the codebase of the project. It's important to do so via the *OFFICIAL* Git repository hosted on [[https://github.com/iWas-Coder/sparky][GitHub]], and not through any tarball or compressed archive to ensure no tampering is done with the code. Appart from that, any ref can be checked out, being ~master~ (the trunk of all dev progress), a tagged commit (e.g. ~v1.0~), an actively maintained version branch (e.g. ~v1.0.y/stable~) or a LTS version branch (e.g. ~v1.0.y/lts~) the preferred ones.

To clone the official repo as well as all its submodules, issue the following command:

#+begin_src sh
git clone --recurse-submodules https://github.com/iWas-Coder/sparky
#+end_src

** Dependencies

(...)
These are the packages needed to be able to build /Sparky/ from source, they are divided by distribution/package manager. Also, a command for each one is added to make the installation of these development dependencies as easy and straightforward as possible.

*** Debian/Ubuntu

Expand Down

0 comments on commit c397704

Please sign in to comment.