public inbox for ~johnnyrichard/olang-devel@lists.sr.ht
 help / color / mirror / code / Atom feed
* [PATCH olang] docs: installation: add information about how to clone the project
@ 2024-10-07 16:29 Carlos Maniero
  2024-10-07 16:30 ` [olang/patches/.build.yml] build success builds.sr.ht
  2024-10-07 21:37 ` [PATCH olang] docs: installation: add information about how to clone the project Johnny Richard
  0 siblings, 2 replies; 3+ messages in thread
From: Carlos Maniero @ 2024-10-07 16:29 UTC (permalink / raw)
  To: ~johnnyrichard/olang-devel; +Cc: Carlos Maniero

Signed-off-by: Carlos Maniero <carlos@maniero.me>
---
I was doing a setup of a new machine and I missed the git clone URL.
I know that we may change the URL in the future but I think that it is
easier for someone that are trying to install olc to have all
information at the same page.

 docs/info/installation.texi | 24 +++++++++++++++++++++---
 1 file changed, 21 insertions(+), 3 deletions(-)

diff --git a/docs/info/installation.texi b/docs/info/installation.texi
index 6ee4a4d..7d63964 100644
--- a/docs/info/installation.texi
+++ b/docs/info/installation.texi
@@ -1,10 +1,28 @@
 @node Installation
 @chapter Installation
 
-This installation assumes you are running an unix like operation system and
-requires @code{make}, @code{makeinfo} and a @strong{c compiler} installed.
+This installation assumes you are running an unix-like operation system.
 
-The following commands will compile the the code and install @code{olc} binary
+@section Dependencies
+
+@itemize @bullet
+@item git
+@item make
+@item makeinfo
+@item c compiler (gcc, clang, etc)
+@end itemize
+
+@section Installing olc from source
+
+The olang is still in its early stages, so it's not packaged for major package
+managers. To install it, clone the source code and follow the installation
+instructions.
+
+@verbatim
+git clone https://git.sr.ht/~johnnyrichard/olang
+@end verbatim
+
+The following commands will compile the code and install @code{olc} binary
 (olang compiler), @code{man} pages and @code{info} docs into your system.
 
 @verbatim

base-commit: 2fcf01737ed421c3aad49712f09063f1693c11d4
-- 
2.46.0


^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2024-10-07 19:38 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2024-10-07 16:29 [PATCH olang] docs: installation: add information about how to clone the project Carlos Maniero
2024-10-07 16:30 ` [olang/patches/.build.yml] build success builds.sr.ht
2024-10-07 21:37 ` [PATCH olang] docs: installation: add information about how to clone the project Johnny Richard

Code repositories for project(s) associated with this public inbox

	https://git.johnnyrichard.com/olang.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox