diff options
author | Cem Keylan <cem@ckyln.com> | 2021-08-31 01:13:15 +0300 |
---|---|---|
committer | Cem Keylan <cem@ckyln.com> | 2021-08-31 01:13:15 +0300 |
commit | 08c5bd21fa02e1b30fe2e4c194d9c615a4daf2c6 (patch) | |
tree | b471d65a2ad20665dc0e0e8f91aa67ac4c0949b1 /src/docs.org | |
parent | 25cfa83501cf9b0a1f79d7d94af13b0866c33aa7 (diff) | |
download | website-08c5bd21fa02e1b30fe2e4c194d9c615a4daf2c6.tar.gz |
website: switch to hugo
Diffstat (limited to 'src/docs.org')
-rw-r--r-- | src/docs.org | 118 |
1 files changed, 0 insertions, 118 deletions
diff --git a/src/docs.org b/src/docs.org deleted file mode 100644 index c8d0380..0000000 --- a/src/docs.org +++ /dev/null @@ -1,118 +0,0 @@ -#+TITLE: Documentation - -Below are sources of documentation regarding Carbs Linux and tools surrounding -it. - -#+TOC: headlines 1 - -* User Manual -:PROPERTIES: -:CUSTOM_ID: user-manual -:END: - -Carbs Linux User Manual aims to be a general-purpose explanation of the -distribution, from the installation steps to the style guide of the project. It -can be accessed or otherwise obtained with various methods: - -** HTML -:PROPERTIES: -:CUSTOM_ID: html -:END: - -You can view the Manual from your browser. The Manual can be viewed as - -- [[file:docs/carbslinux][One HTML page per node]] -- [[file:docs/carbslinux.html][Single HTML page]] - -** Plain text -:PROPERTIES: -:CUSTOM_ID: plain-text -:END: - -You can download [[file:docs/carbslinux.txt][carbslinux.txt]] in order to view the Manual from your preferred -pager. - -#+begin_src sh -curl -LO https://carbslinux.org/docs/carbslinux.txt -less carbslinux.txt -#+end_src - -** Info -:PROPERTIES: -:CUSTOM_ID: info -:ORDERED: t -:END: - -You can install the =carbs-docs= package and either =texinfo= or =info= packages -to view the Manual offline. - -#+begin_src sh -cpt bi info carbs-docs -info carbslinux -#+end_src - -** Source -:PROPERTIES: -:CUSTOM_ID: source -:END: - -You can also acquire the source for generating the Manual, which requires -=emacs= for exporting the Org-mode documentation and =texinfo= for generating -html/info pages. - -#+begin_src sh -git clone git://git.carbslinux.org/docs -#+end_src - -* Installation Instructions -:PROPERTIES: -:CUSTOM_ID: installation-instructions -:END: - -Installation Manual is part of the [[*User Manual][User Manual]], but it can also be obtained -separately: - -- [[file:install.org][HTML]] -- [[file:install.txt][Plaintext]] - -* Carbs Packaging Tools -:PROPERTIES: -:CUSTOM_ID: carbs-packaging-tools -:END: - -CPT User Manual has the implementation details of the package manager utilities. -It can be accessed or otherwise obtained with various methods: - -** HTML -:PROPERTIES: -:CUSTOM_ID: cpt-html -:END: - -You can view the Manual from your browser. The Manual can be viewed as - -- [[file:docs/cpt][One HTML page per node]] -- [[file:docs/cpt.html][Single HTML page]] - -** Plain text -:PROPERTIES: -:CUSTOM_ID: cpt-plain-text -:END: - -You can download [[file:docs/cpt.txt][cpt.txt]] in order to view the Manual from your preferred pager. - -#+begin_src sh -curl -LO https://carbslinux.org/docs/cpt.txt -less cpt.txt -#+end_src - -** Info -:PROPERTIES: -:CUSTOM_ID: cpt-info -:END: - -Info page for CPT is included in the tarball, which can be read offline by -installing either =texinfo= or =info= packages. - -#+begin_src sh -info cpt -#+end_src |