README: update

This commit is contained in:
0x1eef 2024-01-27 23:49:40 -03:00
parent ff73da7f06
commit 899e8f5b3a
2 changed files with 9 additions and 8 deletions

View file

@ -1,7 +1,7 @@
## About
Twenty helps you manage your projects with a web application
that runs on your computer with a minimal amount of effort.
that runs on your computer.
## Features
@ -45,8 +45,8 @@ that runs on your computer with a minimal amount of effort.
## Install
Eventually I hope to publish twenty as a RubyGem. For the time
being installing from source will have to do.
Eventually I hope to publish twenty as a RubyGem. <br>
For the time being installing from source will have to do.
## License

View file

@ -8,19 +8,20 @@ module Twenty
require_relative "twenty-backend/servlet"
require_relative "twenty-backend/migration"
require_relative "twenty-backend/model"
extend FileUtils
##
# @return [String]
# Returns the directory where twenty stores data.
def self.home
def self.data_dir
File.join(Dir.home, ".local", "share", "20")
end
##
# @return [String]
# Returns the default SQLite database.
# Returns the location of the default SQLite database.
def self.default_database
@default_database ||= File.join(home, "database.sqlite")
@default_database ||= File.join(data_dir, "database.sqlite")
end
##
@ -44,8 +45,8 @@ module Twenty
# @api private
def self.prepare_dir
return if File.exist?(default_database)
FileUtils.mkdir_p(home)
FileUtils.touch(default_database)
mkdir_p(data_dir)
touch(default_database)
rescue => ex
warn "prepare_dir error: #{ex.message} (#{ex.class})"
end