Skip to content
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.

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

Improve README #82

Open
puittenbroek opened this issue Oct 14, 2019 · 4 comments
Open

Improve README #82

puittenbroek opened this issue Oct 14, 2019 · 4 comments

Comments

@puittenbroek
Copy link

As title says, symlink what/where? Give some examples like explain how to setup a settings file.
Or how to make said symlink.

@ephraim
Copy link
Owner

ephraim commented Oct 14, 2019

Yeah! Would be nice to have! So do it, please!

Cheers Ephraim

@puittenbroek
Copy link
Author

puittenbroek commented Oct 14, 2019

I couldn't get it to work to begin with due to lack of README. Chicken-egg problem :P
Pointing to something that might give tips/help would help as well.

@timwienk
Copy link
Contributor

I fixed some issues in #84 .

There doesn't seem to be any additional configuration needed, other than that the URL of the addon has to end in ".git".

Regarding the symlinks, I can't be sure (it's not my README text), but it probably mentions this because it git clones the addons into a directory named after the URL (i.e. if the repository is https://github.com/ephraim/lcurse.git, the directory will be named lcurse). If the name of the repository does not exactly match the name of the addon, it'll have to be symlinked to the correct name.

@puittenbroek
Copy link
Author

I wouldn't know where to perform the git clone to begin with. That would be a first step in a proper readme. I work fulltime as a software developer, so no technical skills are missing. But not in the mood to read source code to figure out where I should perform my commands..

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants