Skip to content

Commit efb6684

Browse files
committed
explain it a bit more
1 parent 28cbe17 commit efb6684

File tree

1 file changed

+28
-7
lines changed

1 file changed

+28
-7
lines changed

README.md

Lines changed: 28 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,25 +11,46 @@ That is how I call packages not available on the repositories of an user. It can
1111

1212
`pkg.list` contains a newline-separated list of all packages, and you currently have to register them manually. You can easily do this by running `fpkg add`.
1313

14-
This list is currently being used solely for `fpkg` to know which packages it has to update. The update happens by simply issuing a `git pull` inside the selected directory!
14+
This list is currently being used solely for `fpkg` to know which packages it has to update. The update happens by simply issuing a `git pull` inside the selected directory.
1515

16-
`ii/` contains little scripts written manually (with the help of templates tho') for installation of packages.
16+
`ii/` contains little scripts written manually (with a template provided) for installing and uninstalling packages. Since not every package uses the same steps for building, that was the solution I came up with. `fpkg add` already redirects you to write those steps using your favorite text editor, though!
1717

18-
Since not every package uses the same steps for building, that was the solution I came up with. `fpkg add` already redirects you to write those steps using your favorite text editor, though!
18+
### Requirements
1919

20-
### Setup
20+
You just need basic knowledge on Bash scripting, like knowing what variables are and that's it.
21+
22+
Besides that, you'll also need installed on your system:
23+
24+
- awk
25+
- coreutils
26+
- sed
27+
28+
Nothing much, that 2nd item should be installed on every Linux system lol
29+
30+
### Basic setup
2131

2232
Just put the script somewhere in your `$PATH`, I use `/usr/local/bin/` on mine for example.
2333

24-
As for the directory containing all packages, that is literally the first line of code (after the classic `#!/bin/bash` of course). You just change `$FPKGDIR` to whatever you want, and if the directory doesn't exist, `fpkg` will make it for you!
34+
As for the directory containing all packages, you just change `$FPKGDIR` to whatever you want, and if the directory doesn't exist, `fpkg` will make it for you!
2535

2636
And for the text editor, it's also as simple. Change `$EDITOR` to your favorite text editor.
2737

28-
Then, run `fpkg add` to register and write the .ii's of all the packages you have on your $FPKGDIR.
38+
Then, run `fpkg add` to register and write the .ii's for all the packages you have on your $FPKGDIR.
2939

3040
And then, you can run `fpkg update` just to check if everything is working and if your stuff is up to date of course.
3141

32-
That's it, you're good to go! And don't forget to run `fpkg help` to know some extra stuff too!
42+
That's it, you're good to go! And don't forget to run `fpkg help` to get some extra stuff too!
43+
44+
### Logging
45+
46+
This is used to track down the build process of a package, so that if something goes wrong, the user can just open the log file and find out.
47+
48+
On `fpkg`, logging works as follows:
49+
50+
- Two variables, $FPKG_LOG and $LOG_FMT are commented out. They respectively correspond to the location of the log file and the format of the timestamp on the log file.
51+
- Those variables are commented out by default, disabling the logging feature. To enable it, just uncomment them.
52+
53+
I'm not sure if I keep it this way, it was the best I could think of.
3354

3455
### Contributing
3556

0 commit comments

Comments
 (0)