Futura-Py / TimerX

A fluent Timer App, made completely in Python
https://timerx-app.netlify.app
MIT License
37 stars 5 forks source link

patch(readme): readme spelling errors and more #21

Closed im-coder-lg closed 2 years ago

im-coder-lg commented 2 years ago

So, I corrected basic spelling errors, which might have happened during a speed type, added some spaces in the Supported Platforms' emojis so that it'd look neat, arranged all emojis and replaced Keybinds with Keybindings in Keybindings to Play/Pause, that seems more correct. Also removed the Zorin part in Linux(Supported platforms) since I haven't installed it yet(lazy me). More info in the release tasks discussion. Also, can we use the new icon as an emoji? I have a plan just for that.

im-coder-lg commented 2 years ago

We need to change more things too. Also, forgot to tell, I didn't remove Zorin from the Readme, I commented it out(<!--comment-->)

sumeshir26 commented 2 years ago

What more things do we neex to change? And, emoji as icon? I have never heard of that!

im-coder-lg commented 2 years ago

It's kind of a HTML cheat, here, look at this:

<div align=center>
<img alt="TimerX icon" width="48px" src="https://raw.githubusercontent.com/sumeshir26/TimerX/master/assets/logo_new.png">
</div>

Output:

TimerX icon

You can adjust the pixel size with the width tag.

We could try that

im-coder-lg commented 2 years ago

What more things do we neex to change?

Need to check, brb.

sumeshir26 commented 2 years ago

Dont update anything! the actions error is caused by you using tje version 1.0-test In setup.py it explicitly specifies the version aas 1.0 so you need to specify the version while running tje action as 1.0

im-coder-lg commented 2 years ago

okay, testing again.

im-coder-lg commented 2 years ago

Well, now it works. Are we heading straight to v1.0 or alpha build, then beta and finally, 1.0?

sumeshir26 commented 2 years ago

Yes

im-coder-lg commented 2 years ago

Wait wdym? We are making an alpha release first?

im-coder-lg commented 2 years ago

Also is the icon-to-emoji okay? Maybe I can put it on the README.

im-coder-lg commented 2 years ago

Also, pyvenv.cfg has a private Windows PATH(we need to remove that and replace it)... How about asking users to make a special path for the Python VENV, if at all they use it?

im-coder-lg commented 2 years ago

Also, I was wondering about adding a nice contributing guide here, what do you say? Adding that and maybe even a wiki/website, you can deploy it, I can take care of it. Need your opinions on this.

im-coder-lg commented 2 years ago

/ping @sumeshir26 can you review, tell if I can change the header to the one with our new icon and/or tell a go-ahead for merge?

sumeshir26 commented 2 years ago

@im-coder-lg No need to add tkinter to requirements.txt since it is a built in module in python but others like play sound and darkdetect are not

sumeshir26 commented 2 years ago

Yeah, you can change the header. (Also, to me it somehow seems that we are confusing not-nef more than helping on his Branch/Fork Question 😂

im-coder-lg commented 2 years ago

@im-coder-lg No need to add tkinter to requirements.txt since it is a built in module in python but others like play sound and darkdetect are not

Ok... But in Replit, on first run, it asks me what the heck is Tkinter? Well, maybe let it be there so that users that use the cloud like Replit or Gitpod can install Tk easily.

im-coder-lg commented 2 years ago

Yeah, you can change the header.

Will do...

Also, to me it somehow seems that we are confusing not-nef more than helping on his Branch/Fork Question 😂

Well, maybe for this I will have to elaborate.

im-coder-lg commented 2 years ago

Testing release workflow so that this doesn't fail during the release creation.

sumeshir26 commented 2 years ago

Okay, How do you suggest to make a website?

im-coder-lg commented 2 years ago

Okay, How do you suggest to make a website?

Documentation? We'll make a docs/ directory here. I will use a workflow that deploys my favourite CODEDOC to GitHub Pages, and we are good to go.

im-coder-lg commented 2 years ago

We could also use Jekyll that can use Vercel... Let's take Jekyll, that's widely supported and we will use Netlify for the website deployment since it has Netlify CMS that could allow us to edit without going to GitHub.

sumeshir26 commented 2 years ago

Hmm.. Action fails badly

im-coder-lg commented 2 years ago

We need to use only integers, no alpha tags. Maybe we could name the release as alpha and use 1.0.01 or something else.

sumeshir26 commented 2 years ago

Ok, name could be 0.9

im-coder-lg commented 2 years ago

Changing now!

im-coder-lg commented 2 years ago

LGTM, people! Let's get ready to merge after a final test.

im-coder-lg commented 2 years ago

Merging! image