1203
submitted 1 year ago* (last edited 1 year ago) by mypasswordis1234@lemmy.world to c/opensource@lemmy.ml

I beg you, if you are a developer of an open source app or program - add screenshots of your app to the README file. When looking for the perfect app, I had to install dozens of them just to see what the user interface looked like and whether it suits me. This will allow users to decide if the app they choose will suit them... Please, don't think about it, just do it....

you are viewing a single comment's thread
view the rest of the comments
[-] xT1TANx@lemmy.world 47 points 1 year ago

Wait what? I thought the read me file was to put as little info as possible to prove how awesome anyone was who can use the program.

[-] shalva97@lemmy.sdfeu.org 18 points 1 year ago

Including the documentation link, which only has incomplete getting started section

[-] pivot_root@lemmy.world 8 points 1 year ago

Getting Started

  1. Clone the repo
  2. Install dependencies
  3. Compile the project: TODO
  4. Copy the executable to /bin
  5. Add your app.json config to ~/.config/app*

* IMPORTANT. APP WILL NOT RUN WITHOUT THIS

[-] droans@lemmy.world 4 points 1 year ago

Oh hey, they have an example.app.json file. Let's check that out!

{}
this post was submitted on 14 Aug 2023
1203 points (97.8% liked)

Open Source

31665 readers
277 users here now

All about open source! Feel free to ask questions, and share news, and interesting stuff!

Useful Links

Rules

Related Communities

Community icon from opensource.org, but we are not affiliated with them.

founded 5 years ago
MODERATORS