Re: rethink of the Readme.md at the root of the project

2022-10-27 Thread Julian Hyde
Glad you're thinking about the design of README.md. It is an important entry point to the project for developers (and potential contributors). But bear in mind a couple of other entry points: the project's home page, and the source tarball. The home page should be the default entry point for peop

Re: rethink of the Readme.md at the root of the project

2022-10-27 Thread Calvin Kirs
On Thu, Oct 27, 2022 at 9:32 PM Josh Fischer wrote: > > On Wed, Oct 26, 2022 at 8:00 AM Bertil Chapuis wrote: > > > > > > > > > On 26 Oct 2022, at 13:22, Antoine Drabble > > > wrote: > > > > > > 1. I like the logo at the start, it looks more welcoming. That is probably > > > another topic, but

Re: rethink of the Readme.md at the root of the project

2022-10-27 Thread Calvin Kirs
+1 to keeping baremaps as the name, btw, as I mentioned before, If the final discussion is unanimous, then it's best to submit a ticket to the brand team to approve the name as soon as possible. On Thu, Oct 27, 2022 at 11:43 PM Josh Fischer wrote: > > +1 to keeping baremaps as the name. > > On T

Re: rethink of the Readme.md at the root of the project

2022-10-27 Thread Josh Fischer
+1 to keeping baremaps as the name. On Thu, Oct 27, 2022 at 10:04 AM Bertil Chapuis wrote: > > > > On 27 Oct 2022, at 15:32, Josh Fischer wrote: > > > > Either is fine with me, Would you give context on why you chose > > Baremaps or why'd you like to change it to Warbler? What is the > > meani

Re: rethink of the Readme.md at the root of the project

2022-10-27 Thread Bertil Chapuis
> On 27 Oct 2022, at 15:32, Josh Fischer wrote: > > Either is fine with me, Would you give context on why you chose > Baremaps or why'd you like to change it to Warbler? What is the > meaning behind them? Originally, I thought that we would have to release the domain names (baremaps.com, bar

Re: rethink of the Readme.md at the root of the project

2022-10-27 Thread Josh Fischer
On Wed, Oct 26, 2022 at 8:00 AM Bertil Chapuis wrote: > > > > > On 26 Oct 2022, at 13:22, Antoine Drabble wrote: > > > > 1. I like the logo at the start, it looks more welcoming. That is probably > > another topic, but should we try to find a good logo, or is the logo on the > > Baremaps website

Re: rethink of the Readme.md at the root of the project

2022-10-26 Thread Léonard Besseau
> > > - The live reloading feature (dev mode) is quite unique but often goes > under the radar. Should we make a gif or a video? > I agree. The hot-reload is a feature that you often see advertised and is one that is really appreciated in projects that offer it. A gif seems like a good way to demo

Re: rethink of the Readme.md at the root of the project

2022-10-26 Thread Bertil Chapuis
> On 26 Oct 2022, at 13:22, Antoine Drabble wrote: > > 1. I like the logo at the start, it looks more welcoming. That is probably > another topic, but should we try to find a good logo, or is the logo on the > Baremaps website our official logo? I really liked the DALL-E > warbler images, maybe

Re: rethink of the Readme.md at the root of the project

2022-10-26 Thread Bertil Chapuis
> On 26 Oct 2022, at 13:17, Josh Fischer wrote: > > I ran `mvn clean install` and that worked fine, but I'm thinking "what > do I do next”? From the terminal: unzip baremaps-cli/target/baremaps.zip export PATH=$PATH:`pwd`/baremaps/bin From IntelliJ: https://github.com/baremaps/baremaps/tree/

Re: rethink of the Readme.md at the root of the project

2022-10-26 Thread Josh Fischer
Sorry, I misspoke on your (1.) point. I haven't followed the legal side much as of yet. I'll check into this and see what I can find about if this is the logo submitted, etc. On Wed, Oct 26, 2022 at 6:41 AM Josh Fischer wrote: > > Sure, I"d be happy to. Overall I agree with the points you made.

Re: rethink of the Readme.md at the root of the project

2022-10-26 Thread Josh Fischer
Sure, I"d be happy to. Overall I agree with the points you made. Let me do a little thinking/digging through the code and see what I come up with. On Wed, Oct 26, 2022 at 6:22 AM Antoine Drabble wrote: > > I think that it's a very good idea to update the readme! > > I have quickly looked at a fe

Re: rethink of the Readme.md at the root of the project

2022-10-26 Thread Antoine Drabble
I think that it's a very good idea to update the readme! I have quickly looked at a few readme files on Github from different Apache projects. Some projects like Hadoop or Calcite just link to an external website. Each readme is quite different. I really like this one [1], which is another projec

Re: rethink of the Readme.md at the root of the project

2022-10-26 Thread Josh Fischer
>From what I can see the README and documentation shows how to download already created executables. but doesn't show how to package a release of baremaps or run it locally. I ran `mvn clean install` and that worked fine, but I'm thinking "what do I do next"? On Wed, Oct 26, 2022 at 4:43 AM Andr

Re: rethink of the Readme.md at the root of the project

2022-10-26 Thread Andrea Borghi
- Were there parts of the documentation/examples that you had difficulty understanding? it's more a problem to find them easily then understanding IMHO. - Cartographer wants to create maps and developers want to code. Should we make have two different quick start guides? that's a good point!

Re: rethink of the Readme.md at the root of the project

2022-10-26 Thread Bertil Chapuis
> What do you think? It's a good idea, the documentation should help people get started quickly. The migration to Apache is also an opportunity to revise the web site [1]. Some additional thoughts/questions: - The live reloading feature (dev mode) is quite unique but often goes under the radar

rethink of the Readme.md at the root of the project

2022-10-26 Thread Andrea Borghi
Hi guys, I was thinking: in my personal experience I generally like when I land on a project, and at a first glance of the readme I get the necessary infos to build and start "playing" with the project. I think that the current readme does not allow for this "copy/paste and let's go" feeling