Extend documentation #17
Comments
|
Hi, Even if you don't read french, you'll be able to read shell commands and have a look at the screenshots that show some of the possibilities of hl. Another difference with ccze (I think) is that you don't need to write new code when you want to create a new configuration, you just need to add the new configuration to an existing configuration file, or to create it in a new configuration file, or to just specify the options list as command line arguments. I'll appreciate your comments about hl. Thanks. Martial |
|
Hi, Martial |
|
I checked the commits for https://github.com/mbornet-hl/hl/commits/master/README.md and looks much better now! I would also like to see sections INSTALL and CONTRIBUTE in the README, so that people know how to install it and how to contribute. If you don't want to make the deb and rpm yourself, maybe somebody can contribute (hint: I am a Debian Developer :)).. |
|
Hi, Regards, Martial |
|
Can you share a link to the hl page in Arch Linux? I could check out how the packaging is done in Arch. Even better, add that link to your README. I am currently struggling with how to correctly build hl. WIP: https://github.com/ottok/hl/tree/master/debian I also have some difficulties navigating the repository, there are so many files for which I don't understand the purpose. As a packager I should be able to understand what all the packages are and where they go. There is currently no "make install" in the project to look at. I also noticed the repository has a lot of excess stuff that don't belong to version control, for example binary files. |
|
And what exactly are the build dependencies? |
I added a link to an ArchLinux web page in the README : https://aur.archlinux.org/packages/hl-git/ . |
|
So indeed the best only build dependency is flex. But as you can see in the
copy-paste output, it didn't build with the gcc and flex version is n
Debian unstable.
|
|
My system is a Devuan ascii : Here is how I install hl on a Devuan system : Nothing more. Here are the versions of cc /lex / yacc : |
|
Ok, I got it building in Debian Buster. Seems the code is incompatible with the Flex version in Debian Sid (latest flex). You should look into it. The quality assurance tool in Lintian also complained about quite a few things:
I also myself noticed quite a few quality issues:
|
|
Dear @mbornet-hl, could you be so kind to generate |
|
Dear Aleksandr, |
|
Currently it is a bit complicated to install HL entirely without having read all your documentation (readme, wiki, blog page). It's a pity, the first thing a user, even an expert, is looking for is a section that explains from A to Z how to install or compile the application. Most of the time it is better if this section is right after the introduction and the Features, or at the end of the Readme, even if it means referring to the Wiki. I suggest the following text for Linux: InstallLinuxRequirements
Debian based distro instalaltion: sudo apt install gcc flex make gitBuild & Installgit clone --depth=1 https://github.com/mbornet-hl/hlcd hl
make clean
make# executable
sudo cp hl /usr/local/bin/hl
# documentation
mkdir -p /usr/local/share/man/man1/ /usr/local/share/man/man5/
sudo cp man1/hl.1 /usr/local/share/man/man1/
sudo cp man5/hl.5 /usr/local/share/man/man5/
# if you use bash, the project include a completion script
sudo apt install bash-completion
sudo mkdir -p /usr/local/share/bash-completion/completions/
sudo cp completion/complete_hl /usr/local/share/bash-completion/completions/hl
# install some default configuration files
sudo mkdir -p /etc/hl/config.d/
sudo cp config_files/* /etc/hl/config.d/
mkdir -p $HOME/.config/hl/config.d/
cp config_files/* $HOME/.config/hl/config.d/
# add this variable export to .profile or .bashrc if you use a custom location
export HL_CONF=$HOME/.config/hl/config.d:/etc/hl/config.d |
This seems like a nifty tool but it is a bit difficult to get started.
Please add a section that documents how to install it.
If it is included in some Linux distro, please link to it. I did not find any
hlpackage at https://packages.ubuntu.com/search?suite=groovy&searchon=names&keywords=hl as an example.Also, please tell visitors in the intro how this tool differs from other similar tools, such as https://github.com/cornet/ccze.
The text was updated successfully, but these errors were encountered: