osn-commons/trunk/README.org

* OSN Commons

OSN Commons is a collection of reusable code and components
designed to simplify the development of software projects. Inspired by
GNULib, OSN Commons provides you a wide range of functionalities that
can be easily integrated into your projects, giving you a smooth
development experience so that you can focus on important things.

** Getting Started

To get started, follow these steps:

**** Download OSN Commons

You can clone the entire repository:
#+BEGIN_SRC bash
  git clone https://github.com/onesoft-sudo/commons.git
#+END_SRC
Or, you can browse the code, and pick the tools you need and only
download them. Most of these programs and tools are standalone.

**** Requirements

Ensure that you have the required runtimes installed to be able to
use some of the programs included in OSN commons. Here is the full
list of tools you need to have installed:

+ Node.js v20 or later
+ A POSIX-compliant shell (e.g. Dash)
      
**** Include the tools in your project

You can just copy and paste these programs into your project, as
most of these are standalone and will work as expected.
We recommend putting these tools inside a specific directory like
=build-aux= or =scripts=.

** Licensing

Copyright (C) 2024 OSN, Inc.

OSN Commons is licensed under the [[https://gnu.org/licenses/gpl-3.0.html][GNU General Public License v3.0 or later]].
It is a free software project.

[[https://www.gnu.org/graphics/gplv3-with-text-136x68.png]]
1	* OSN Commons
2
3	OSN Commons is a collection of reusable code and components
4	designed to simplify the development of software projects. Inspired by
5	GNULib, OSN Commons provides you a wide range of functionalities that
6	can be easily integrated into your projects, giving you a smooth
7	development experience so that you can focus on important things.
8
9	** Getting Started
10
11	To get started, follow these steps:
12
13	**** Download OSN Commons
14
15	You can clone the entire repository:
16	#+BEGIN_SRC bash
17	git clone https://github.com/onesoft-sudo/commons.git
18	#+END_SRC
19	Or, you can browse the code, and pick the tools you need and only
20	download them. Most of these programs and tools are standalone.
21
22	**** Requirements
23
24	Ensure that you have the required runtimes installed to be able to
25	use some of the programs included in OSN commons. Here is the full
26	list of tools you need to have installed:
27
28	+ Node.js v20 or later
29	+ A POSIX-compliant shell (e.g. Dash)
30
31	**** Include the tools in your project
32
33	You can just copy and paste these programs into your project, as
34	most of these are standalone and will work as expected.
35	We recommend putting these tools inside a specific directory like
36	=build-aux= or =scripts=.
37
38	** Licensing
39
40	Copyright (C) 2024 OSN, Inc.
41
42	OSN Commons is licensed under the [[https://gnu.org/licenses/gpl-3.0.html][GNU General Public License v3.0 or later]].
43	It is a free software project.
44
45	[[https://www.gnu.org/graphics/gplv3-with-text-136x68.png]]