Skip to content

Latest commit

 

History

History
131 lines (99 loc) · 4.69 KB

README.md

File metadata and controls

131 lines (99 loc) · 4.69 KB



Downloads (stable)ContributingDisclaimers

What is it?

CanUseTimer is an open source, writed in Python, speedcubing and multiplatform timer created to work in a terminal or command prompt window (CLI interface). Because this the program is soft and run anywhere, it means that it can run in probally any computer with bad hardware and any operating system (Windows, Linux and MacOS X). And It's Open Source project, it means that you can install it for free and study the source code of program if you want.

In future I will create a grafical interface based on it, but I don't know a good grafical interface framework to use in my project, but probally this will take a long time. If you know a good grafical interface framework please tell me in a Issue

ℹ️ Note: Dont tell me about TKinter, I've tried it and went wrong.

Can I contribute to project?

Yes, you can! I will verify your issue or pull request, and if I like the ideia, I will implement in my software. So don't be shy to share something good.


Release notes 🗒️

Stable 0.2.2.1 ✅

  • Add sounds for a few actions;
  • Removed --start parameter;
  • Added --show parameter;
  • optimization reworks;
  • Bug fixes.
  • For while there's no unstable versions.

Install

Stable

The stable version is the most recommended to install in your machine because there's less bugs, have installers for all systems and you don't need know about programing and Python to run it.

Install

Chose your Operating system:

System Latest version File
Windows 0.2.2.1 CanUseTimer-v0.2.2.1-Windows_Setup.exe
Linux 0.2.2.1 CanUseTimer-v0.2.2.1-Linux.tar.gz
Mac OS - Comming soon

Old Versions here.

Unstable

The unstable version is a version that is in constant development and you can see new features constantly, but this version may come with bugs of new implementations, recommended only if you want to check what is comming and test it.

⚠️ This type of version only have Linux installer (Because the developer only uses Linux).

Install

Linux

To get the unstable version you only need to clone this repository with:

git clone https://github.com/Samuel-de-Oliveira/CanUseTimer.git
cd CanUseTimer

after this you can run it with Python (sudo python Main.py) or install using the follow comand: ./install.sh. To update type git pull and install it again.

Windows

There's no installers for Windows, but if you want you can compile the Python code using the Pyinstaller project. Click here to take a tutorial about the compilation.

Also if you want to update to see what came, you can just type git pull and recompile everything.

Run from source (With Python)

But if you don't want to install you can run directly from source using Python. To do this process you need install Python 3.10 or higher with pip, then you should to install the requirements using pip install -r requirements.txt or pip3 install -r requirements.txt.

Then you can run with this command in your terminal:

python Main.py

ℹ️ Use a Python virtual environmet, beacuse the unstable version can make comflicts with you python libraries. to create one type python -m venv env in the project folder.


Why use?

  • Lightweight program (Almost 1MB of space on Linux and 10MB for Windows);
  • Run all platforms (Windows, Linux 🐧);
  • Don't need internet (but you can't update it);
  • Open source (Read the GPLv3 licensse for more info). 🔓

Disclaimers! ⚠️

  • This is the terminal version, without grafical interface;
  • This program is tested only in Linux and Windows, and not else;
  • this is a BETA version, means that the final version is on progress;
  • If you found bugs please report to fast fixing in Github issues.


Created by: Samuel de Oliveira 2021 - 2024