Skip to content

Added Installation section which includes basic instructions on how t… #118

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Arsivnet wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Added Installation section which includes basic instructions on how t… #118

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
30d0db0
Added Installation section which includes basic instructions on how t…
Arsivnet Dec 28, 2025
aec01f7
Update README.md
Arsivnet Jan 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,25 @@ APIs with a consistent API look.
qLibc is published under 2-clause BSD license known as Simplified BSD License.
Please refer the LICENSE document included in the package for more details.

## Installation

qlibc uses GNU AutoTools as the primary tool for compilation. Simply execute the following commands while in the main directory of the project.

```bash
./configure
make
sudo make install
```

Alternatively, you can use Cmake. qLibc requires at least GNU99 and confirmed to be compiling in GNU23
Copy link
Copy Markdown
Owner

@wolkykim wolkykim Dec 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I expect all the Linux/Linux-like users to use autotools and CMake for Windows.
Do you think we should include Windows installation instructions instead?

Copy link
Copy Markdown
Author

@Arsivnet Arsivnet Jan 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think both would be good. There's always new people coming to Linux these days. For windows we could add steps both for visual studio and VScode, also maybe a cmd/powershell option.


```bash
mkdir build
cd build
cmake ..
sudo make install
```

Comment on lines +26 to +27
Copy link
Copy Markdown
Owner

@wolkykim wolkykim Jan 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's take this part out for now. Not sure if this should be the officially recommended way.

Copy link
Copy Markdown
Author

@Arsivnet Arsivnet Jan 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just removed that section and pushed

## API Reference

* [qlibc Core API Reference](https://wolkykim.github.io/qlibc/doc/html/files.html)
Expand Down